package com.example.educational.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2WebMvc;

import java.util.ArrayList;
import java.util.List;

/**
 * Knife4jConfig类，用于配置Knife4j，即Swagger的增强工具。
 * 便于后台接口测试
 */
@Configuration
@EnableSwagger2WebMvc
public class Knife4jConfig {

    /**
     * 创建并配置Swagger文档生成器Docket。
     *
     * @return Docket对象，用于生成Swagger文档
     */
    @Bean
    public Docket adminApiConfig() {
        // 创建参数列表
        List<Parameter> pars = new ArrayList<>();
        ParameterBuilder tokenPar = new ParameterBuilder();
        tokenPar.name("token")
                .description("用户token")
                .defaultValue("")
                .modelRef(new ModelRef("string"))
                .parameterType("header")
                .required(false)
                .build();
        pars.add(tokenPar.build());
        // 添加头部参数

        // 创建Swagger Docket对象
        Docket adminApi = new Docket(DocumentationType.SWAGGER_2)
                .groupName("adminApi")  // 分组名
                .apiInfo(adminApiInfo())  // 配置API信息
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.example.educational"))  // 设置扫描的包路径
                .paths(PathSelectors.regex("/.*"))  // 匹配的URL路径
                .build()
                .globalOperationParameters(pars);  // 设置全局参数
        return adminApi;
    }

    /**
     * 创建API信息对象，描述API文档的基本信息。
     *
     * @return ApiInfo对象，包含API文档的标题、描述、版本等信息
     */
    private ApiInfo adminApiInfo() {
        return new ApiInfoBuilder()
                .title("后台管理系统-API文档")  // API文档标题
                .description("本文档描述了后台管理系统微服务接口定义")  // API文档描述
                .version("1.0")  // 版本号
                .contact(new Contact("bida", "http://www.lj-txy.love", "1411850978@qq.com"))  // 联系信息
                .build();
    }
}

